Skip to main content

Registro Geral

Para efetuar o upload de um documento do tipo Registro Geral, basta enviar uma requisição POST conforme demonstrado abaixo. O seu código interno é o 17.

POST URL Ambiente/documents/upload

IdentificadorValor
Content-typemultipart/form-data
IDEXA-API-KEY[api_key]

Payload​

ParâmetroDescriçãoObrigatórioTipoExemplos
filesDocumento(s) a ser(em) processado(s)SimFile"arquivo.pdf"
typeTipo do documento enviadoSimInteger17
pagesPáginas a serem analisadas (Quando extensão for pdf)NãoString"1,2,5-10"
externalIdId externo para controle do documento (não pode repetir)NãoString"0001"

Exemplo​

('files',('arquivo.pdf',open('/path/to/file/arquivo.pdf','rb'),'application/pdf'))
{
  "type": 17,
  "pages": "1,2,5-10",
  "externalId": "0001"
}

Retorno​

Status code 200​

Ao enviar um documento, o retorno 200 dado pela api, irá enviar um objeto data nulo pois a inferência do documento ainda será feita. Para obter o resultado da Inteligência Artificial, é necessário utilizar a requisição vista na próxima sessão.

ParâmetroDescriçãoTipoExemplos
idCódigo interno do documentoUUID"95893394-337c-429c-..."
externalIdId externo para controle do documento (não pode repetir)String"0001"
typeTipo do documento enviadoInteger17
statusSituação do documento (0-Received, 1-Finished, 2-Error, 3-In Progress)Integer0
statusDescSituação do documento (RECEIVED, FINISHED, IN_PROGRESS, ERROR)String"FINISHED"
createdAtHorário de criação do registroDatetime"01/01/2023 00:00:00.0000"
updatedAtHorário de atualização do registroDatetime"01/01/2023 00:00:00.0000"

Exemplo​

{
"id": "bc1bc4ea-8964-4bb7-97cc-2d77d39908d8",
"externalId": "0001",
"type": 17,
"status": 0,
"statusDesc": "RECEIVED",
"createdAt": "2022-10-14 14:38:50.045316",
"updatedAt": "2022-10-14 14:38:50.045316"
}